Document new api

svn path=/trunk/; revision=17928

diff --git a/ChangeLog b/ChangeLog
index dc8f97010485124cc6c2c52f9d740cdbed75e997..2aa7c9e20a7d372205240d1e02d14adb2e7128ea 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2007-05-26  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkentrycompletion.c: Document new api
+
 2007-05-26  Richard Hult  <richard@imendio.com>
 
        * gtk/gtkprinter.c: (gtk_printer_set_location): Fix typo to get the

diff --git a/gtk/gtkentrycompletion.c b/gtk/gtkentrycompletion.c
index 4b0da9769a6bb9a70dc3cfce866827ada2aaa86c..8df785c158e63fd4ecccf5d020ef5804277372e0 100644 (file)
--- a/gtk/gtkentrycompletion.c
+++ b/gtk/gtkentrycompletion.c
@@ -1641,11 +1641,12 @@ gtk_entry_completion_real_insert_prefix (GtkEntryCompletion *completion,
  * @completion: a #GtkEntryCompletion
  * 
  * Get the original text entered by the user that triggered
- * the completion or NULL if there's no completion ongoing.
+ * the completion or %NULL if there's no completion ongoing.
+ * 
+ * Returns: the prefix for the current completion
  * 
  * Since: 2.12
  **/
-
 const gchar*
 gtk_entry_completion_get_completion_prefix (GtkEntryCompletion *completion)
 {
@@ -1937,6 +1938,16 @@ gtk_entry_completion_get_popup_single_match (GtkEntryCompletion *completion)
   return completion->priv->popup_single_match;
 }
 
+/**
+ * gtk_entry_completion_set_inline_selection:
+ * @completion: a #GtkEntryCompletion
+ * @inline_selection: %TRUE to do inline selection
+ * 
+ * Sets whether it is possible to cycle through the possible completions
+ * inside the entry.
+ * 
+ * Since: 2.12
+ **/
 void
 gtk_entry_completion_set_inline_selection (GtkEntryCompletion *completion,
                                           gboolean inline_selection)
@@ -1953,6 +1964,16 @@ gtk_entry_completion_set_inline_selection (GtkEntryCompletion *completion,
     }
 }
 
+/**
+ * gtk_entry_completion_get_inline_selection:
+ * @completion: a #GtkEntryCompletion
+ *
+ * Returns %TRUE if inline-selection mode is turned on.
+ *
+ * Returns: %TRUE if inline-selection mode is on
+ *
+ * Since: 2.12
+ **/
 gboolean
 gtk_entry_completion_get_inline_selection (GtkEntryCompletion *completion)
 {